<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: SimpleField.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.core;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.Arrays;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.Map;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>import org.jsimpledb.util.ByteWriter;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>/**<a name="line.15"></a>
<span class="sourceLineNo">016</span> * A simple {@link Field}.<a name="line.16"></a>
<span class="sourceLineNo">017</span> *<a name="line.17"></a>
<span class="sourceLineNo">018</span> * &lt;p&gt;<a name="line.18"></a>
<span class="sourceLineNo">019</span> * {@link SimpleField}s have these requirements and properties:<a name="line.19"></a>
<span class="sourceLineNo">020</span> * &lt;ul&gt;<a name="line.20"></a>
<span class="sourceLineNo">021</span> *  &lt;li&gt;They have an associated {@link FieldType} representing the domain of possible values&lt;/li&gt;<a name="line.21"></a>
<span class="sourceLineNo">022</span> *  &lt;li&gt;Theys can serve as the element sub-field for {@link SetField}s and {@link ListField}s,<a name="line.22"></a>
<span class="sourceLineNo">023</span> *      and the key and value sub-fields for {@link MapField}s.&lt;/li&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> *  &lt;li&gt;They can be indexed.&lt;/li&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;/ul&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> *<a name="line.26"></a>
<span class="sourceLineNo">027</span> * @param &lt;T&gt; Java type for the field's values<a name="line.27"></a>
<span class="sourceLineNo">028</span> */<a name="line.28"></a>
<span class="sourceLineNo">029</span>public class SimpleField&lt;T&gt; extends Field&lt;T&gt; {<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>    final FieldType&lt;T&gt; fieldType;<a name="line.31"></a>
<span class="sourceLineNo">032</span>    final boolean indexed;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    ComplexField&lt;?&gt; parent;<a name="line.34"></a>
<span class="sourceLineNo">035</span>    Map&lt;CompositeIndex, Integer&gt; compositeIndexMap;         // maps index to this field's offset in field list<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>    /**<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * Constructor.<a name="line.38"></a>
<span class="sourceLineNo">039</span>     *<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * @param name the name of the field<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * @param storageId field storage ID<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * @param schema schema version<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * @param fieldType field type<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * @param indexed whether this field is indexed<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * @throws IllegalArgumentException if any parameter is null<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * @throws IllegalArgumentException if {@code name} is invalid<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * @throws IllegalArgumentException if {@code storageId} is zero or less<a name="line.47"></a>
<span class="sourceLineNo">048</span>     */<a name="line.48"></a>
<span class="sourceLineNo">049</span>    SimpleField(String name, int storageId, Schema schema, FieldType&lt;T&gt; fieldType, boolean indexed) {<a name="line.49"></a>
<span class="sourceLineNo">050</span>        super(name, storageId, schema, fieldType.getTypeToken());<a name="line.50"></a>
<span class="sourceLineNo">051</span>        this.fieldType = fieldType;<a name="line.51"></a>
<span class="sourceLineNo">052</span>        this.indexed = indexed;<a name="line.52"></a>
<span class="sourceLineNo">053</span>    }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>// Public methods<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span>    /**<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * Get the {@link FieldType} associated with this field.<a name="line.58"></a>
<span class="sourceLineNo">059</span>     *<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * @return this field's type<a name="line.60"></a>
<span class="sourceLineNo">061</span>     */<a name="line.61"></a>
<span class="sourceLineNo">062</span>    public FieldType&lt;T&gt; getFieldType() {<a name="line.62"></a>
<span class="sourceLineNo">063</span>        return this.fieldType;<a name="line.63"></a>
<span class="sourceLineNo">064</span>    }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    /**<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * Determine whether this field is indexed.<a name="line.67"></a>
<span class="sourceLineNo">068</span>     *<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * @return true if this field is indexed<a name="line.69"></a>
<span class="sourceLineNo">070</span>     */<a name="line.70"></a>
<span class="sourceLineNo">071</span>    public boolean isIndexed() {<a name="line.71"></a>
<span class="sourceLineNo">072</span>        return this.indexed;<a name="line.72"></a>
<span class="sourceLineNo">073</span>    }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    /**<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * Set the value of this field in the given object.<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * Does not alter the schema version of the object.<a name="line.77"></a>
<span class="sourceLineNo">078</span>     *<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * @param tx transaction<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @param id object id<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @param value new value<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @throws DeletedObjectException if no object with ID equal to {@code id} is found<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @throws StaleTransactionException if this transaction is no longer usable<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * @throws IllegalArgumentException if {@code tx} or {@code id} is null<a name="line.84"></a>
<span class="sourceLineNo">085</span>     */<a name="line.85"></a>
<span class="sourceLineNo">086</span>    public void setValue(Transaction tx, ObjId id, T value) {<a name="line.86"></a>
<span class="sourceLineNo">087</span>        if (tx == null)<a name="line.87"></a>
<span class="sourceLineNo">088</span>            throw new IllegalArgumentException("null tx");<a name="line.88"></a>
<span class="sourceLineNo">089</span>        tx.writeSimpleField(id, this.storageId, value, false);<a name="line.89"></a>
<span class="sourceLineNo">090</span>    }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    @Override<a name="line.92"></a>
<span class="sourceLineNo">093</span>    @SuppressWarnings("unchecked")<a name="line.93"></a>
<span class="sourceLineNo">094</span>    public T getValue(Transaction tx, ObjId id) {<a name="line.94"></a>
<span class="sourceLineNo">095</span>        if (tx == null)<a name="line.95"></a>
<span class="sourceLineNo">096</span>            throw new IllegalArgumentException("null tx");<a name="line.96"></a>
<span class="sourceLineNo">097</span>        return (T)tx.readSimpleField(id, this.storageId, false);<a name="line.97"></a>
<span class="sourceLineNo">098</span>    }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span>    @Override<a name="line.100"></a>
<span class="sourceLineNo">101</span>    public boolean hasDefaultValue(Transaction tx, ObjId id) {<a name="line.101"></a>
<span class="sourceLineNo">102</span>        if (tx == null)<a name="line.102"></a>
<span class="sourceLineNo">103</span>            throw new IllegalArgumentException("null tx");<a name="line.103"></a>
<span class="sourceLineNo">104</span>        return tx.hasDefaultValue(id, this);<a name="line.104"></a>
<span class="sourceLineNo">105</span>    }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span>    @Override<a name="line.107"></a>
<span class="sourceLineNo">108</span>    public &lt;R&gt; R visit(FieldSwitch&lt;R&gt; target) {<a name="line.108"></a>
<span class="sourceLineNo">109</span>        return target.caseSimpleField(this);<a name="line.109"></a>
<span class="sourceLineNo">110</span>    }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>    @Override<a name="line.112"></a>
<span class="sourceLineNo">113</span>    public String toString() {<a name="line.113"></a>
<span class="sourceLineNo">114</span>        return (this.indexed ? "indexed " : "") + "field `" + this.name + "' of type " + this.fieldType.typeToken;<a name="line.114"></a>
<span class="sourceLineNo">115</span>    }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span>// Non-public methods<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span>    @Override<a name="line.119"></a>
<span class="sourceLineNo">120</span>    SimpleFieldStorageInfo&lt;T&gt; toStorageInfo() {<a name="line.120"></a>
<span class="sourceLineNo">121</span>        return new SimpleFieldStorageInfo&lt;T&gt;(this, this.parent != null ? this.parent.storageId : 0);<a name="line.121"></a>
<span class="sourceLineNo">122</span>    }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span>    @Override<a name="line.124"></a>
<span class="sourceLineNo">125</span>    void copy(ObjId srcId, ObjId dstId, Transaction srcTx, Transaction dstTx) {<a name="line.125"></a>
<span class="sourceLineNo">126</span>        dstTx.writeSimpleField(dstId, this.storageId, srcTx.readSimpleField(srcId, this.storageId, false), false);<a name="line.126"></a>
<span class="sourceLineNo">127</span>    }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>    /**<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * Encode the given value.<a name="line.130"></a>
<span class="sourceLineNo">131</span>     *<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * @param obj value to encode<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * @return encoded value, or null if value is the default value<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * @throws IllegalArgumentException if {@code obj} cannot be encoded<a name="line.134"></a>
<span class="sourceLineNo">135</span>     */<a name="line.135"></a>
<span class="sourceLineNo">136</span>    byte[] encode(Object obj) {<a name="line.136"></a>
<span class="sourceLineNo">137</span>        T value;<a name="line.137"></a>
<span class="sourceLineNo">138</span>        try {<a name="line.138"></a>
<span class="sourceLineNo">139</span>            value = this.fieldType.validate(obj);<a name="line.139"></a>
<span class="sourceLineNo">140</span>        } catch (IllegalArgumentException e) {<a name="line.140"></a>
<span class="sourceLineNo">141</span>            throw new IllegalArgumentException("can't set " + this + " to value " + obj + ": " + e.getMessage(), e);<a name="line.141"></a>
<span class="sourceLineNo">142</span>        }<a name="line.142"></a>
<span class="sourceLineNo">143</span>        final ByteWriter writer = new ByteWriter();<a name="line.143"></a>
<span class="sourceLineNo">144</span>        this.fieldType.write(writer, value);<a name="line.144"></a>
<span class="sourceLineNo">145</span>        final byte[] result = writer.getBytes();<a name="line.145"></a>
<span class="sourceLineNo">146</span>        return Arrays.equals(result, this.fieldType.getDefaultValue()) ? null : result;<a name="line.146"></a>
<span class="sourceLineNo">147</span>    }<a name="line.147"></a>
<span class="sourceLineNo">148</span>}<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>




























































</pre>
</div>
</body>
</html>
